/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.jooby.crash;

import com.google.common.collect.Sets;
import com.google.inject.Binder;
import com.google.inject.Key;
import com.google.inject.TypeLiteral;
import com.google.inject.multibindings.Multibinder;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import org.crsh.plugin.CRaSHPlugin;
import org.crsh.plugin.PluginContext;
import org.jooby.Env;
import org.jooby.Jooby.Module;
import org.jooby.Registry;
import org.jooby.Route;
import org.jooby.WebSocket;
import static org.jooby.funzy.Throwing.throwingSupplier;
import org.slf4j.bridge.SLF4JBridgeHandler;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.ServiceLoader;
import java.util.Set;
import java.util.concurrent.CompletableFuture;

/**
 * <h1>crash</h1>
 * <p>
 * Connect, monitor or use virtual machine resources via SSH, telnet or HTTP with
 * <a href="http://www.crashub.org">CRaSH remote shell.</a>
 * </p>
 *
 * <h2>usage</h2>
 *
 * <pre>{@code
 * import org.jooby.crash;
 *
 * {
 *   use(new Crash());
 * }
 * }</pre>
 *
 * <p>
 * That's all you need to get <a href="http://www.crashub.org">CRaSH</a> up and running!!!
 * </p>
 * <p>
 * Now is time to see how to connect and interact with the <a href="http://www.crashub.org">CRaSH
 * shell</a>
 * </p>
 *
 * <h2>commands</h2>
 * <p>
 * You can write additional shell commands using Groovy or Java, see the
 * <a href="http://www.crashub.org/1.3/reference.html#developping_commands">CRaSH documentation for
 * details</a>. CRaSH search for commands in the <code>cmd</code> folder.
 * </p>
 * <p>
 * Here is a simple ‘hello’ command that could be loaded from <code>cmd/hello.groovy</code> folder:
 * </p>
 * <pre>{@code
 * package commands
 *
 * import org.crsh.cli.Command
 * import org.crsh.cli.Usage
 * import org.crsh.command.InvocationContext
 *
 * class hello {
 *
 *  &#64;Usage("Say Hello")
 *  &#64;Command
 *  def main(InvocationContext context) {
 *      return "Hello"
 *  }
 *
 * }
 * }</pre>
 *
 * <p>
 * Jooby adds some additional attributes and commands to InvocationContext that you can access from
 * your command:
 * </p>
 *
 * <ul>
 * <li>registry: Access to {@link Registry}.</li>
 * <li>conf: Access to {@link Config}.</li>
 * </ul>
 *
 * <h3>routes command</h3>
 * <p>
 * The <code>routes</code> print all the application routes.
 * </p>
 *
 * <h3>conf command</h3>
 * <p>
 * The <code>conf tree</code> print the application configuration tree (configuration precedence).
 * </p>
 *
 * <p>
 * The <code>conf props [path]</code> print all the application properties, sub-tree or a single
 * property if <code>path</code> argument is present.
 * </p>
 *
 * <h2>connectors</h2>
 *
 * <h3>HTTP connector</h3>
 * <p>
 * The HTTP connector is a simple yet powerful collection of HTTP endpoints where you can
 * run
 * <a href="http://www.crashub.org/1.3/reference.html#developping_commands">CRaSH
 * command</a>:
 * </p>
 *
 * <pre>{@code
 *
 * {
 *   use(new Crash()
 *      .plugin(HttpShellPlugin.class)
 *   );
 * }
 * }</pre>
 *
 * <p>
 * Try it:
 * </p>
 *
 * <pre>
 * GET /api/shell/thread/ls
 * </pre>
 *
 * <p>
 * OR:
 * </p>
 *
 * <pre>
 * GET /api/shell/thread ls
 * </pre>
 *
 * <p>
 * The connector listen at <code>/api/shell</code>. If you want to mount the connector some
 * where
 * else just set the property: <code>crash.httpshell.path</code>.
 * </p>
 *
 * <h3>SSH connector</h3>
 * <p>
 * Just add the <a href=
 * "https://mvnrepository.com/artifact/org.crashub/crash.connectors.ssh">crash.connectors.ssh</a>
 * dependency to your project.
 * </p>
 *
 * <p>
 * Try it:
 * </p>
 *
 * <pre>
 * ssh -p 2000 admin@localhost
 * </pre>
 *
 * <p>
 * Default user and password is: <code>admin</code>. See how to provide a custom
 * <a href="http://www.crashub.org/1.3/reference.html#pluggable_auth">authentication
 * plugin</a>.
 * </p>
 *
 * <h3>telnet connector</h3>
 * <p>
 * Just add the <a href=
 * "https://mvnrepository.com/artifact/org.crashub/crash.connectors.telnet">crash.connectors.telnet</a>
 * dependency to your project.
 * </p>
 *
 * <p>
 * Try it:
 * </p>
 *
 * <pre>
 * telnet localhost 5000
 * </pre>
 *
 * <p>
 * Checkout complete
 * <a href="http://www.crashub.org/1.3/reference.html#_telnet_connector">telnet
 * connector</a> configuration.
 * </p>
 *
 * <h3>web connector</h3>
 * <p>
 * Just add the <a href=
 * "https://mvnrepository.com/artifact/org.crashub/crash.connectors.web">crash.connectors.web</a>
 * dependency to your project.
 * </p>
 *
 * <p>
 * Try it:
 * </p>
 *
 * <pre>
 * GET /shell
 * </pre>
 *
 * <p>
 * A web shell console will be ready to go at <code>/shell</code>. If you want to mount the
 * connector some where else just set the property: <code>crash.webshell.path</code>.
 * </p>
 *
 * @author edgar
 * @since 1.0.0
 */
@SuppressWarnings({"unchecked", "rawtypes"})
public class Crash implements Module {

  static {
    if (!SLF4JBridgeHandler.isInstalled()) {
      SLF4JBridgeHandler.removeHandlersForRootLogger();
      SLF4JBridgeHandler.install();
    }
  }

  private static final Key<Set<CRaSHPlugin>> PLUGINS = Key
    .get(new TypeLiteral<Set<CRaSHPlugin>>() {
    });

  private final Set<Class> plugins = new HashSet<>();

  private final ClassLoader loader;

  /**
   * Creates a new {@link Crash} module.
   *
   * @param loader Class loader to use or <code>null</code>.
   */
  public Crash(final ClassLoader loader) {
    this.loader = Optional.ofNullable(loader).orElse(getClass().getClassLoader());
  }

  /**
   * Creates a new {@link Crash} module.
   */
  public Crash() {
    this(null);
  }

  /**
   * Add a custom plugin to CRaSH.
   *
   * @param plugin Plugin class.
   * @return This module.
   */
  public Crash plugin(final Class<? extends CRaSHPlugin> plugin) {
    plugins.add(plugin);
    return this;
  }

  @Override
  public void configure(final Env env, final Config conf, final Binder binder) {
    Properties props = new Properties();
    if (conf.hasPath("crash")) {
      conf.getConfig("crash").entrySet().forEach(
        e -> props.setProperty("crash." + e.getKey(), e.getValue().unwrapped().toString()));
    }

    Map<String, Object> attributes = new HashMap<>();
    attributes.put("conf", conf);

    // connectors.web on classpath?
    boolean webShell = loader.getResource("META-INF/resources/js/crash.js") != null;
    if (webShell) {
      plugins.add(WebShellPlugin.class);
      WebShellPlugin.install(env, conf);
    }

    if (plugins.contains(HttpShellPlugin.class)) {
      HttpShellPlugin.install(env, conf);
    }

    Multibinder<CRaSHPlugin> mb = Multibinder.newSetBinder(binder, CRaSHPlugin.class);
    plugins.forEach(it -> mb.addBinding().to(it));

    CrashBootstrap crash = new CrashBootstrap();

    CompletableFuture<PluginContext> ctx = new CompletableFuture<>();
    binder.bind(PluginContext.class).toProvider(throwingSupplier(ctx::get)::get);

    env.onStart(r -> {
      Set<Route.Definition> routes = r.require(Route.KEY);
      Set<WebSocket.Definition> sockets = r.require(WebSocket.KEY);
      attributes.put("registry", r);
      attributes.put("routes", routes);
      attributes.put("websockets", sockets);
      attributes.put("env", env);

      Set plugins = Sets.newHashSet(r.require(PLUGINS));
      ServiceLoader.load(CRaSHPlugin.class, this.loader).forEach(plugins::add);

      ctx.complete(crash.start(loader, props, attributes, plugins));
    });

    env.onStop(crash::stop);
  }

  @Override
  public Config config() {
    return ConfigFactory.parseResources(getClass(), "crash.conf");
  }

}
